<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Ball Balancing Plate: Serial Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="logo.jpg"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Ball Balancing Plate
   &#160;<span id="projectnumber">1.0.0</span>
   </div>
   <div id="projectbrief">Object recognition and control algorithm software.</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('class_serial.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">Serial Class Reference<div class="ingroups"><a class="el" href="group___serial.html">Serial</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="Serial" -->
<p><code>#include &lt;<a class="el" href="serial_8hpp_source.html">serial.hpp</a>&gt;</code></p>

<p><a href="class_serial-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___serial.html#ga53e1e7d545e9ca3776224344ea4c3719">Serial</a> (char *portName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The Constructor.  <a href="group___serial.html#ga53e1e7d545e9ca3776224344ea4c3719"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___serial.html#ga5b32c394c0ff923a4ef1c13cfb20a6ba">~Serial</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The destructor.  <a href="group___serial.html#ga5b32c394c0ff923a4ef1c13cfb20a6ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___serial.html#ga3874e3c10b006dc37584d45a928ae9db">ReadData</a> (char *buffer, unsigned int nbChar)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data from serial port.  <a href="group___serial.html#ga3874e3c10b006dc37584d45a928ae9db"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___serial.html#ga3cce4a34142e8e2adbda131d43103e01">WriteData</a> (char *buffer, unsigned int nbChar)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Write data to serial port.  <a href="group___serial.html#ga3cce4a34142e8e2adbda131d43103e01"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___serial.html#gaa53e46b5c8556152d5d3306fdab4117c">IsConnected</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the connection status.  <a href="group___serial.html#gaa53e46b5c8556152d5d3306fdab4117c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">HANDLE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serial.html#ae4bd96b28d4eb348a1aca7ea456f82f5">hSerial</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_serial.html">Serial</a> handler.  <a href="#ae4bd96b28d4eb348a1aca7ea456f82f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serial.html#ad788fe882057ff8393e6a59767eb3aa7">connected</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Connection status.  <a href="#ad788fe882057ff8393e6a59767eb3aa7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">COMSTAT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serial.html#a956a7895cca74bc01261857842581f06">status</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Information about the connection.  <a href="#a956a7895cca74bc01261857842581f06"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">DWORD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serial.html#a6762daaadf619992f60902783ae88727">errors</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Last error.  <a href="#a6762daaadf619992f60902783ae88727"></a><br/></td></tr>
</table>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ad788fe882057ff8393e6a59767eb3aa7"></a><!-- doxytag: member="Serial::connected" ref="ad788fe882057ff8393e6a59767eb3aa7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_serial.html#ad788fe882057ff8393e6a59767eb3aa7">Serial::connected</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Connection status. </p>

</div>
</div>
<a class="anchor" id="a6762daaadf619992f60902783ae88727"></a><!-- doxytag: member="Serial::errors" ref="a6762daaadf619992f60902783ae88727" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DWORD <a class="el" href="class_serial.html#a6762daaadf619992f60902783ae88727">Serial::errors</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Last error. </p>

</div>
</div>
<a class="anchor" id="ae4bd96b28d4eb348a1aca7ea456f82f5"></a><!-- doxytag: member="Serial::hSerial" ref="ae4bd96b28d4eb348a1aca7ea456f82f5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">HANDLE <a class="el" href="class_serial.html#ae4bd96b28d4eb348a1aca7ea456f82f5">Serial::hSerial</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="class_serial.html">Serial</a> handler. </p>

</div>
</div>
<a class="anchor" id="a956a7895cca74bc01261857842581f06"></a><!-- doxytag: member="Serial::status" ref="a956a7895cca74bc01261857842581f06" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">COMSTAT <a class="el" href="class_serial.html#a956a7895cca74bc01261857842581f06">Serial::status</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Information about the connection. </p>

</div>
</div>
</div><!-- contents -->
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="class_serial.html">Serial</a>      </li>

    <li class="footer">Generated on Wed Jun 5 2013 12:20:17 for Ball Balancing Plate by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>
